<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: fsm_sii.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fsm__sii_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">fsm_sii.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>EtherCAT slave information interface FSM structure.  
<a href="#details">More...</a></p>

<p><a href="fsm__sii_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__fsm__sii.html">ec_fsm_sii</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Slave information interface FSM.  <a href="structec__fsm__sii.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a6b596f5c1a4212b443a4429b2baed8f2"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structec__fsm__sii.html">ec_fsm_sii</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__sii_8h.html#a6b596f5c1a4212b443a4429b2baed8f2">ec_fsm_sii_t</a></td></tr>
<tr class="separator:a6b596f5c1a4212b443a4429b2baed8f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ab31614ec8c650bb9ad5c8370f43113b9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__sii_8h.html#ab31614ec8c650bb9ad5c8370f43113b9">ec_fsm_sii_addressing_t</a> { <a class="el" href="fsm__sii_8h.html#ab31614ec8c650bb9ad5c8370f43113b9ae9d46f26f8811736432dc46c5cb5ccbf">EC_FSM_SII_USE_INCREMENT_ADDRESS</a>, 
<a class="el" href="fsm__sii_8h.html#ab31614ec8c650bb9ad5c8370f43113b9a37be562464a8536ed644aaf88fdd6705">EC_FSM_SII_USE_CONFIGURED_ADDRESS</a>
 }<tr class="memdesc:ab31614ec8c650bb9ad5c8370f43113b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">SII access addressing mode.  <a href="fsm__sii_8h.html#ab31614ec8c650bb9ad5c8370f43113b9">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ab31614ec8c650bb9ad5c8370f43113b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aaabcdf786b590efeab32a3d22e0128fd"><td class="memItemLeft" align="right" valign="top"><a id="aaabcdf786b590efeab32a3d22e0128fd"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__sii_8h.html#aaabcdf786b590efeab32a3d22e0128fd">ec_fsm_sii_init</a> (<a class="el" href="fsm__sii_8h.html#a6b596f5c1a4212b443a4429b2baed8f2">ec_fsm_sii_t</a> *, <a class="el" href="structec__datagram__t.html">ec_datagram_t</a> *)</td></tr>
<tr class="memdesc:aaabcdf786b590efeab32a3d22e0128fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:aaabcdf786b590efeab32a3d22e0128fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8caf4d1dad1846b4f2604c646cf5e5f8"><td class="memItemLeft" align="right" valign="top"><a id="a8caf4d1dad1846b4f2604c646cf5e5f8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__sii_8h.html#a8caf4d1dad1846b4f2604c646cf5e5f8">ec_fsm_sii_clear</a> (<a class="el" href="fsm__sii_8h.html#a6b596f5c1a4212b443a4429b2baed8f2">ec_fsm_sii_t</a> *)</td></tr>
<tr class="memdesc:a8caf4d1dad1846b4f2604c646cf5e5f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a8caf4d1dad1846b4f2604c646cf5e5f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38e7b8c01e605fff2c33fac389d91600"><td class="memItemLeft" align="right" valign="top"><a id="a38e7b8c01e605fff2c33fac389d91600"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__sii_8h.html#a38e7b8c01e605fff2c33fac389d91600">ec_fsm_sii_read</a> (<a class="el" href="fsm__sii_8h.html#a6b596f5c1a4212b443a4429b2baed8f2">ec_fsm_sii_t</a> *, <a class="el" href="globals_8h.html#a8d9ffff7dbe1babaa4786a63f2860d57">ec_slave_t</a> *, uint16_t, <a class="el" href="fsm__sii_8h.html#ab31614ec8c650bb9ad5c8370f43113b9">ec_fsm_sii_addressing_t</a>)</td></tr>
<tr class="memdesc:a38e7b8c01e605fff2c33fac389d91600"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the SII read state machine. <br /></td></tr>
<tr class="separator:a38e7b8c01e605fff2c33fac389d91600"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07f4477300db5c173a24df91f6f22073"><td class="memItemLeft" align="right" valign="top"><a id="a07f4477300db5c173a24df91f6f22073"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__sii_8h.html#a07f4477300db5c173a24df91f6f22073">ec_fsm_sii_write</a> (<a class="el" href="fsm__sii_8h.html#a6b596f5c1a4212b443a4429b2baed8f2">ec_fsm_sii_t</a> *, <a class="el" href="globals_8h.html#a8d9ffff7dbe1babaa4786a63f2860d57">ec_slave_t</a> *, uint16_t, const uint16_t *, <a class="el" href="fsm__sii_8h.html#ab31614ec8c650bb9ad5c8370f43113b9">ec_fsm_sii_addressing_t</a>)</td></tr>
<tr class="memdesc:a07f4477300db5c173a24df91f6f22073"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the SII write state machine. <br /></td></tr>
<tr class="separator:a07f4477300db5c173a24df91f6f22073"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a55a4196ef667eb7320c07c1e290330"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__sii_8h.html#a7a55a4196ef667eb7320c07c1e290330">ec_fsm_sii_exec</a> (<a class="el" href="fsm__sii_8h.html#a6b596f5c1a4212b443a4429b2baed8f2">ec_fsm_sii_t</a> *)</td></tr>
<tr class="memdesc:a7a55a4196ef667eb7320c07c1e290330"><td class="mdescLeft">&#160;</td><td class="mdescRight">Executes the SII state machine.  <a href="#a7a55a4196ef667eb7320c07c1e290330">More...</a><br /></td></tr>
<tr class="separator:a7a55a4196ef667eb7320c07c1e290330"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3227702bf3cc7a1a6b7ce235b2fb8bbf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__sii_8h.html#a3227702bf3cc7a1a6b7ce235b2fb8bbf">ec_fsm_sii_success</a> (<a class="el" href="fsm__sii_8h.html#a6b596f5c1a4212b443a4429b2baed8f2">ec_fsm_sii_t</a> *)</td></tr>
<tr class="memdesc:a3227702bf3cc7a1a6b7ce235b2fb8bbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns, if the master startup state machine terminated with success.  <a href="#a3227702bf3cc7a1a6b7ce235b2fb8bbf">More...</a><br /></td></tr>
<tr class="separator:a3227702bf3cc7a1a6b7ce235b2fb8bbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>EtherCAT slave information interface FSM structure. </p>

<p class="definition">Definition in file <a class="el" href="fsm__sii_8h_source.html">fsm_sii.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a6b596f5c1a4212b443a4429b2baed8f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b596f5c1a4212b443a4429b2baed8f2">&#9670;&nbsp;</a></span>ec_fsm_sii_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structec__fsm__sii.html">ec_fsm_sii</a> <a class="el" href="fsm__sii_8h.html#a6b596f5c1a4212b443a4429b2baed8f2">ec_fsm_sii_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structec__fsm__sii.html" title="Slave information interface FSM. ">ec_fsm_sii</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="fsm__sii_8h_source.html#l00055">55</a> of file <a class="el" href="fsm__sii_8h_source.html">fsm_sii.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ab31614ec8c650bb9ad5c8370f43113b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab31614ec8c650bb9ad5c8370f43113b9">&#9670;&nbsp;</a></span>ec_fsm_sii_addressing_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="fsm__sii_8h.html#ab31614ec8c650bb9ad5c8370f43113b9">ec_fsm_sii_addressing_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SII access addressing mode. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab31614ec8c650bb9ad5c8370f43113b9ae9d46f26f8811736432dc46c5cb5ccbf"></a>EC_FSM_SII_USE_INCREMENT_ADDRESS&#160;</td><td class="fielddoc"><p>Use auto-increment addressing. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab31614ec8c650bb9ad5c8370f43113b9a37be562464a8536ed644aaf88fdd6705"></a>EC_FSM_SII_USE_CONFIGURED_ADDRESS&#160;</td><td class="fielddoc"><p>Use configured addresses. </p>
</td></tr>
</table>

<p class="definition">Definition at line <a class="el" href="fsm__sii_8h_source.html#l00048">48</a> of file <a class="el" href="fsm__sii_8h_source.html">fsm_sii.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a7a55a4196ef667eb7320c07c1e290330"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a55a4196ef667eb7320c07c1e290330">&#9670;&nbsp;</a></span>ec_fsm_sii_exec()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_fsm_sii_exec </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="fsm__sii_8h.html#a6b596f5c1a4212b443a4429b2baed8f2">ec_fsm_sii_t</a> *&#160;</td>
          <td class="paramname"><em>fsm</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Executes the SII state machine. </p>
<dl class="section return"><dt>Returns</dt><dd>false, if the state machine has terminated </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fsm</td><td>finite state machine </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="fsm__sii_8c_source.html#l00137">137</a> of file <a class="el" href="fsm__sii_8c_source.html">fsm_sii.c</a>.</p>

</div>
</div>
<a id="a3227702bf3cc7a1a6b7ce235b2fb8bbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3227702bf3cc7a1a6b7ce235b2fb8bbf">&#9670;&nbsp;</a></span>ec_fsm_sii_success()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_fsm_sii_success </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="fsm__sii_8h.html#a6b596f5c1a4212b443a4429b2baed8f2">ec_fsm_sii_t</a> *&#160;</td>
          <td class="paramname"><em>fsm</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns, if the master startup state machine terminated with success. </p>
<dl class="section return"><dt>Returns</dt><dd>non-zero if successful. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fsm</td><td>Finite state machine </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="fsm__sii_8c_source.html#l00152">152</a> of file <a class="el" href="fsm__sii_8c_source.html">fsm_sii.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="fsm__sii_8h.html">fsm_sii.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
